CourseAssembly Class Reference

List of all members.

Public Member Functions
	CourseAssembly ($courseID=0)
	listAssemblies ()
	createAssembly ()
	setData ($data)
	validateName ($name)
	validateDescription ($desc)
	validateSetting ($cat, $value)
	setName ($ID, $name)
	setDescription ($ID, $desc)
	setSetting ($ID, $cat, $value)
	getDefaultData ()
	showEditForm ($ID=0)
	getAssembly ($ID=0)
	countAssemblies ()
	applyAssembly ($ID)
	deleteAssembly ($ID)
	moveUp ($ID)
Public Attributes
	$courseID
	$categories
	$modGroupList
	$extToolsList

---

Member Function Documentation

CourseAssembly::applyAssembly

(

$

ID

)

Speichert die Einstellungen einer Kurs-Vorlage für den durch den Konstruktor festgelegten Kurs.

public

Parameters:

int

$ID ID der zu übernehmenden Vorlage

Returns:

bool Erfolgswert

CourseAssembly::countAssemblies

(

)

Gibt die Anzahl der vorhandenen Kurs-Vorlagen zurück.

public

Returns:

int Anzahl der Kurs-Vorlagen.

CourseAssembly::CourseAssembly

(

$

courseID = 0

)

Konstruktor

public

Parameters:

int

$courseID Kurs-ID

CourseAssembly::createAssembly

(

)

Erzeugt den grundlegenden Datenbankeintrag für die Vorlage und liefert die ID zurück.

private

Returns:

int ID des erzeugten Eintrags

CourseAssembly::deleteAssembly

(

$

ID

)

Löscht eine Vorlage und die zugehörigen Einstellungen.

public

Parameters:

int

$ID ID der zu löschenden Vorlage

Returns:

bool Erfolgswert

CourseAssembly::getAssembly

(

$

ID = 0

)

Gibt eine oder alle verfügbaren Kurs-Vorlagen zurück.

public

Parameters:

int

$ID ID der abzurufenden Vorlage oder 0 für alle

Returns:

array Array mit mehreren Vorlagen oder Array einer Vorlage

CourseAssembly::getDefaultData

(

)

Gibt ein Array mit Standardeinstellungen zurück.

private

Returns:

array Standardeinstellungen einer neuen Vorlage

CourseAssembly::listAssemblies

(

)

Listet alle verfügbaren konfektionierten Kurse auf.

public

Returns:

bool true, wenn eine Liste ausgegeben wurde, false, wenn noch keine Vorlagen erstellt wurden

CourseAssembly::moveUp

(

$

ID

)

Ändert die Anzeigereihenfolge, indem die übergebene Vorlage um eins nach oben verschoben wird.

public

Parameters:

int

$ID ID der zu verschiebenden Vorlage

Returns:

bool Erfolgswert

CourseAssembly::setData

(

$

data

)

Versucht, die im übergebenen Array vorhandenen Daten anhand der assoziativen Array-Indizes als neue Vorlagen-Daten abzuspeichern. Dabei kann es sich zum Beispiel um das $_POST-Array handeln. Es werden dabei entweder alle oder keine Daten gespeichert. Sind einige der Daten fehlerhaft, wird ein String mit Fehlermeldungen zurückgeliefert, sonst der boolsche Wert true.

public

Parameters:

array

$data Assoziatives Array mit den neuen Werten

Returns:

mixed String mit Fehlermeldungen oder true bei Erfolg

CourseAssembly::setDescription	(	$	ID,
		$	desc
	)

Speichert den übergebenen String als neue Beschreibung dieser Vorlage. Der String sollte vorher mit der Methode validateDescription() validiert worden sein!

public

Parameters:

	int	$ID ID der Kurs-Vorlage
	string	$desc Zu speichernde Beschreibung

Returns:

boolean Erfolgswert

CourseAssembly::setName	(	$	ID,
		$	name
	)

Speichert den übergebenen String als neuen Namen dieser Vorlage. Der String sollte vorher mit der Methode validateName() validiert worden sein!

public

Parameters:

	int	$ID ID der Kurs-Vorlage
	string	$name Zu speichernder Name

Returns:

boolean Erfolgswert

CourseAssembly::setSetting	(	$	ID,
		$	cat,
		$	value
	)

Speichert den übergebenen Wert als neue Einstellung dieser Vorlage. Der Wert sollte vorher mit der Methode validateSetting() validiert worden sein!

public

Parameters:

	int	$ID ID der Kurs-Vorlage
	int	$cat Kategorie der Einstellung
	mixed	$value Zu speichernde Einstellung

Returns:

boolean Erfolgswert

CourseAssembly::showEditForm

(

$

ID = 0

)

Zeigt das Bearbeitungsformular für eine Kurs-Vorlage an.

public

Parameters:

int

$ID ID der zu bearbeitenden Vorlage oder 0 für eine neue

Returns:

void

CourseAssembly::validateDescription

(

$

desc

)

Überprüft die übergebene Beschreibung auf Gültigkeit.

public

Parameters:

string

$desc Der zu überprüfende String

Returns:

mixed String mit Fehlerangabe oder true bei Erfolg

CourseAssembly::validateName

(

$

name

)

Überprüft den übergebenen Namen auf Gültigkeit.

public

Parameters:

string

$name Der zu überprüfende String

Returns:

mixed String mit Fehlerangabe oder true bei Erfolg

CourseAssembly::validateSetting	(	$	cat,
		$	value
	)

Überprüft die übergebene Einstellung auf Gültigkeit.

public

Parameters:

	int	$cat Kategorie der Einstellung
	mixed	$value Die zu überprüfende Einstellung

Returns:

mixed String mit Fehlerangabe oder true bei Erfolg

---

Member Data Documentation

CourseAssembly::$categories

CourseAssembly::$courseID

CourseAssembly::$extToolsList

CourseAssembly::$modGroupList

---

The documentation for this class was generated from the following file:

• web/courses/classes/class.courseassembly.inc.php